Account Management Biz Api

(0 reviews)

GET-billingAccountById(Digital To Salesforce)

Get

This operation allows retrieve the billing account information.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

https://[localhost]:[port]/sfdc-sys/v1/{businessId}/billingAccount/{id}

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico	Y
id	string	Billing Account Number	Y

name	value	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	Y

Query Param

name	type	description	required
extendedCharacteristics.name	string	Name of the characteristic to search. Could be different, depending on the use case. For Peacock Mobile Project the value is sourceSystem".	Y
extendedCharacteristics.value	string	The value of the characteristic. For Peacock Mobile Project the values must be Digital	Y

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - list request processed successfully, response body contains an entity corresponding to the requested resource.

{
    "id": "1230495-0039947",
    "href": "https://cwc--dvcpeacpro.sandbox.lightning.force.com/0014C00000pP3EhQAK",
    "ratingType": "Postpaid",
    "name": "billing account name",
    "state": "Active",
    "characteristic": [
        {
            "value": "Y",
            "name": "autoPaymentEnabled"
        }
    ],
    "contact": [
        {
            "contactType": "BillingAddress",
            "contactMedium": [
                {
                    "preferred": true,
                    "characteristic": {
                        "city": "Guaynabo",
                        "country": "US",
                        "postCode": "00969",
                        "stateOrProvince": "PR",
                        "street1": "35 Avenida Juan Carlos de Borbón"
                    }
                }
            ]
        },
        {
            "contactType": "customerAccount",
            "contactMedium": [
                {
                    "preferred": true,
                    "characteristic": {
                        "city": "Guaynabo",
                        "country": "US",
                        "postCode": "00969",
                        "stateOrProvince": "PR",
                        "street1": "35 Avenida Juan Carlos de Borbón"
                    }
                }
            ],
            "relatedParty": {
                "id": "0039947",
                "name": "customer account 1",
                "@type": "CustomerAccountRef"
            }
        },
        {
            "name": "contact 1",
            "contactType": "Primary",
            "contactMedium": [
                {
                    "preferred": true,
                    "characteristic": {
                        "city": "Guaynabo",
                        "country": "US",
                        "postCode": "00969",
                        "stateOrProvince": "PR",
                        "street1": "35 Avenida Juan Carlos de Borbón",
                        "phoneNumber": "2883789299",
                        "emailAddress": "test@lcpr.com"
                    }
                }
            ]
        }
    ],
    "paymentPlan": [
        {
            "paymentMethod": {
                "id": "a6I4C000000ATc0UAG"
            },
            "extendedCharacteristics": [
                {
                    "name": "methodType",
                    "value": "BrainTreeToken"
                },
                {
                    "name": "externalCustomerIdentifier",
                    "value": "686497930"
                },
                {
                    "name": "token",
                    "value": "cGF5bWVudG1ldGhvZF9jY184cnpwNHBib"
                },
                {
                    "name": "externalPaymentMethodIdentifier",
                    "value": "1"
                },
                {
                    "name": "isPrimary",
                    "value": "Y"
                }
            ]
        }
    ],
    "billStructure": {
        "presentationMedia": [
            {
                "name": "Electronic Bill"
            }
        ]
    },
    "@type": "BillingAccount",
    "relatedParty": [
        {
            "id": "a6I4C000000ATc0UAG",
            "@type": "SalesforceBillingAccountRef"
        },
        {
            "id": "12345",
            "role": "CustomerSecurity",
            "@type": "ConsumerPIN"
        }
    ]
}

Definitions

Each of the request parameters is detailed.

name	type	description	required
id	string	Billing Account Number (Salesforce Record Id)	N
href	string	URL reference of the billing account in Salesforce	N
ratingType	string	payment type of the billing account and the options are: Prepaid Postpaid	N
name	string	name of the billing account	N
state	string	Status of the account: Active Suspend Disconnected	N
autopayEnabled	string	indicator of the Auto Pay enabled	N
extendedCharacteristics	array	A list of characteristics that characterize this billingAccount	N
extendedCharacteristics.name	string	Name of the characteristic	N
extendedCharacteristics.value	string	The value of the characteristic	N
contact	array	Contact point for a given account and accessed via some contact medium.	N
contact.partyRoleType	string	Identifies what kind of party role type is linked to the contact	N
contact.contactMedium	array	Indicates the contact medium that could be used to contact the party.	N
contact.contactMedium.preferred	boolean	If true, indicates that is the preferred contact medium.	N
contact.contactMedium.characteristic	object	Any additional characteristic(s) of this contact medium.	N
contact.contactMedium.characteristic.city	string	The city	N
contact.contactMedium. characteristic.country	string	The country	N
contact.contactMedium. characteristic.postCode	string	Postcode	N
contact.contactMedium. characteristic.stateOrProvince	string	State or province	N
contact.contactMedium. characteristic.street1	string	Describes the street	N
contact.contactMedium. characteristic.phoneNumber	string	phone number of the customer	N
contact.contactMedium. characteristic.emailAddress	string	email address of the customer	N
contact.relatedParty	object	Related Entity reference	N
contact.relatedParty.id	string	Customer Account Number (Salesforce Record Id)	N
contact.relatedParty.name	string	name of the Customer account	N
contact.relatedParty.@type	string	type of reference	N
contact.name	string	name of the contact	N
paymentPlan	array	A list of payment plans	N
paymentPlan.paymentMethod	object	A payment method reference	N
paymentPlan.paymentMethod.id	string	internal reference id of the payment method in Salesforce	N
paymentPlan.extendedCharacteristics	array	A list of characteristics that characterize the payment method details	N
paymentPlan.extendedCharacteristics.name	string	Name of the characteristic	N
paymentPlan.extendedCharacteristics.value	string	Value of the characteristic	N
@type	string	Type of the reference	N
relatedParty	array	Related Entity reference	N
relatedParty.id	string	Salesforce reference Id of the billing account	N
relatedParty.@type	string	Referencetype	N
relatedParty.id	string	consumerPIN value	N
relatedParty.role	string	role of the party	N
relatedParty.@type	string	Reference type	N